Get Customer Billing Cycle Definition Eligibility

The Get Customer Billing Cycle Definition Eligibility API is used to retrieve a list of Billing Cycle Definitions (BCDs) that are eligible to be assigned to the customer’s given sub-account.

HTTP URL  
GET api/v2/customer/{id}/eligible-bcd

Eligibility

The Requestor is eligible to request information on the eligible BCDs which were assigned to itself by his parent customer (and can be assigned to his sub-accounts).

API Request

Not applicable

API Response

Response Structure

Parameter Type M/O/CM Description
errorCode String O Failure code. See list below, under ‘Error Codes’ section
errorMessage String O Failure detailed description. See list below, under ‘Error Codes’ section
content Object O Array of main response body object. Displayed when an API call was successful. For a failure it will be empty.
pageable Object O Paging information object. Displayed when an API call was successful. For a failure it will be empty.

Content

Parameter Type M/O/CM Description
id UUID M Billing Cycle Definition Id
name String M Billing Cycle Definition name
description String O General information on the Billing Cycle
periodType String M The Billing Cycle period type. ENUM valid values:
  • DAILY
  • WEEKLY
  • MONTHLY
  • BI_MONTHLY
  • QUARTERLY
  • SEMI_ANNUALLY
  • ANNUALLY
    		•
    startDay Numeric M The starting day of the billing cycle period type ‘periodType’.
    • DAILY: 1
    • WEEKLY: 1–7
    • MONTHLY: 1–30
    • BI_MONTHLY: 1–60
    • QUARTERLY: 1–90
    • SEMI_ANNUALLY: 1–182
    • ANNUALLY: 1–365
    duration Integer The periodType number of iterations concluding a single cycle of the Billing Cycle. For example: Period Type set to WEEKLY Start Day set to 1; Duration set to ‘3’; Resolution: A single billing cycle starts on Monday and lasts 3 weeks.
    invoiceFormat String M The invoice format, either PDF or XML formats, or both formats simultaneously. ENUM valid values: XML, PDF, ALL
    isAutomatic Boolean M Future Feature. Indicates if the Billing Cycle steps will be processed manually or automatically without any human intervention. True – Automatic False - Manual Currently only ‘Automatic’ processing is valid, therefore the API always returns ‘true’
    isExport Boolean M Indicates if the invoice files shall be exported to an external customer directory. External directory location is defined per integration process.

    Error Codes

    In addition to the general success and failure codes, thefollowing error codes are possible.

    Code Message
    GLOBAL_1001 Service unavailable. Please try again
    CUSTOMER_1002 Customer does not exist
    CUSTOMER_1006 Failed to retrieve customer details.

    Examples

    Request Body

    Copy 

                

    Response Body: Success (ACK)

    Copy 
    {
      "errorCode": "",
      "errorMessage": "",
      "content": [
        {
          "id": "e291c23a-2b2b-41dd-895e-b5c145c767de",
          "name": "BCD11-Monthly-1-XML",
          "description": "Monthly XML invoicing",
          "periodType": "MONTHLY",
          "startDay": 1,
          "duration": 1,
          "invoiceFormat": "XML",
          "isAutomatic": true,
          "isExport": true
        },
        {
          "id": "ff74dca6-8e7f-4b85-a42b-13860913b370",
          "name": "BCD13-Weekly-1-PDF",
          "description": "Bi-Weekly PDF invoicing",
          "periodType": "WEEKLY",
          "startDay": 1,
          "duration": 2,
          "invoiceFormat": "PDF",
          "isAutomatic": true,
          "isExport": false
        }
      ],
      "pageable": null
    }

    Response Body: Failure(s) NAK

    Copy 
    {
      "errorCode": "GLOBAL_1001",
      "errorMessage": "Service unavailable. Please try again",
      "content": "",
      "pageable": ""
    }